SlkSettings Class

Contains methods for parsing a file with schema "urn:schemas-microsoft-com:sharepoint-learning-kit:settings" and managing the results.

Namespace: Microsoft.SharePointLearningKit

Assembly: Microsoft.SharePointLearningKit.dll

Syntax
C#

public class SlkSettings

Properties
Name Description
Ð ApprovedAttachmentTypes

Gets the collection of approved attachment file name extensions from the "ApprovedAttachmentTypes" attribute of the "<Settings>" element within the SLK Settings XML file. Each key in this dictionary is a file name extension, including a leading period; for example, ".jpg".

Ð ELearningIisCompatibilityModeExtensions

Gets the collection of file extensions (including the preceding period) for files that should be downloaded to a client in IIS compability mode. That is, these files will be sent in a way similar to how IIS sends the files, but this may cause a decrease in performance. Applies to files within e-learning packages (SCORM and Class Server).

Ð LoggingOptions

Gets the value of the "LoggingOptions" attribute of the "<Settings>" element within the SLK Settings XML file. This specifies what type of logging (if any) of SCORM sequencing actions is enabled for content that supports sequencing.

Ð MaxAttachmentKilobytes

Gets the value of the "MaxAttachmentKilobytes" attribute of the "<Settings>" element within the SLK Settings XML file. This is the maximum size of a file that a learner may attach to an attachment-type question in LRM content, measured in kilobytes.

Ð MimeTypeMappings

Gets the collection of MIME type mappings parsed from "<MimeTypeMapping>" elements within the SLK Settings XML file. Each mapping has a key which is a file name extension including the leading period (for example, ".jpg" or ".jpeg") and an associated MIME type (for example, "image/jpeg"). This MIME type mapping table determines the MIME type returned to the browser when content (for example, images) within e-learning packages are displayed.

Ð NonELearningIisCompatibilityModeExtensions

Gets the collection of file extensions (including the preceding period) for files that should be downloaded to a client in IIS compability mode. That is, these files will be sent in a way similar to how IIS sends the files, but this may cause a decrease in performance. Applies to non-e-learning files.

Ð PackageCacheExpirationMinutes

Gets the value of the "PackageCacheExpirationMinutes" attribute of the "<Settings>" element within the SLK Settings XML file. This is the minimum amount of time that a package is retained in the SharePoint Learning Kit file system cache, measured in minutes. If "PackageCacheExpirationMinutes" is absent, null is returned, which should be interpreted as no expiration (i.e. packages are never removed from the cache).

Ð PackageCacheLocation

Gets the value of the "PackageCacheLocation" attribute of the "<Settings>" element within the SLK Settings XML file. This is the full path to the SharePoint Learning Kit package cache location used for each front-end server. This path can be a network file share so multiple front-end servers can use the same package cache. Note that this path may contain environment variable references such as "%TEMP%".

Ð QueryDefinitions

Gets the collection of query definitions parsed from "<Query>" elements within the SLK Settings XML file.

Ð QuerySetDefinitions

Gets the collection of query set definitions parsed from "<QuerySet>" elements within the SLK Settings XML file.

Ð UserWebListMruSize

Gets the value of the "UserWebListMruSize" attribute of the "<Settings>" element within the SLK Settings XML file. This is the number of Web sites displayed in the most-recently-used list of Web sites in the SharePoint Learning Kit E-Learning Actions page. All Web site references are retained, and the user can display them by clicking a link to see the complete list. The MRU is just the most-recently-used subset of Web sites that's displayed by default.

Ð WhenUploaded

Gets the date/time that the SLK Settings file was uploaded to the database.

Methods
Name Description
Ð FindQueryDefinition

Locates a QueryDefinition in a list of queries given its name.

Ð FindQuerySetDefinition

Locates a QuerySetDefinition in a list of query sets given its name. If requested, the list of queries is searched in addition to the list of query sets; in that case, if a query name matching the query set name is found, a QuerySetDefinition containing only that query is returned.

ÐS ParseSettingsFile

Parses an SLK Settings XML file, i.e. an XML file with schema "urn:schemas-microsoft-com:sharepoint-learning-kit:settings". Returns a new SlkSettings object containing information from the parsed file.